/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

package org.erossi.pigest.model.iva;

import java.util.HashSet;
import java.util.Set;

import org.erossi.common.model.GenericBean;
import org.erossi.common.util.AppCtx;

/**
 * 'AliquotaIva' class: bean che rappresenta l'entità "aliquota iva"
 *
 * @author erossi
 * @version Mar 1, 2009
 */
public class AliquotaIva extends GenericBean {

  private static final long serialVersionUID = 1L;

  private String descrizione;
  private Double aliquota;
  private Set<MovimentoIva> movimentiIva;
  
  /**
   * Crea una nuova istanza della classe
   */
  public AliquotaIva() {
    
    descrizione = null;
    aliquota = null;
    movimentiIva = new HashSet<MovimentoIva>();
    
  }
  
  /**
   * Aggiunge un movimento all'insieme dei movimenti
   *   cui questa aliquota é associata.
   *   
   * @param movimentoIva il movimento iva da aggiungere all'elenco dei movimenti
   */
  public void aggiungiMovimentoIva(MovimentoIva movimentoIva) {
    
    movimentiIva.add(movimentoIva);
    movimentoIva.setAliquota(this);
    
  }

  /**
   * Verifica l'uguaglianza fra due oggetti.
   * 
   * <p>
   *   Nel confronto vengono verificati gli attributi significativi del bean
   *   {@link AliquotaIva}, ovvero sono esclusi quelli che 
   *   appartengono al bean generico {@link org.erossi.common.model.GenericBean}
   *   che il primo estende.
   * </p>
   * <p>
   *   Sono esclusi dalla verifica gli attributi che costituiscono le associazioni/chiavi esterne.
   * </p>
   * <p>
   *   L'uguaglianza verificata é quindi quella <b>semantica</b>.
   * </p>
   * 
   * @param o l'oggetto di cui verificare l'uguaglianza
   */
  public boolean equals (Object o) {

    if (o == null) return false;
    if (!(o instanceof AliquotaIva)) return false;
    if (this == o) return true;  
    
    boolean equals = false;
    
    AliquotaIva a = (AliquotaIva) o;
    
    if (super.nullSafeEquals(a.getDescrizione(), this.getDescrizione())) {
      if (super.nullSafeEquals(a.getAliquota(), this.getAliquota())) {
        equals = true;
      }
    }
    
    return equals;
    
  }
  
  /**
   * Calcola l'hash per l'oggetto corrente.
   * 
   * <p>
   *   L'hash dell'oggetto é calcolato come somma degli hash dei suoi attributi,
   *   esclusi quelli che appartengono al bean generico 
   *   {@link org.erossi.common.model.GenericBean}.
   * </p>
   * <p>
   *   Sono esclusi dalla verifica gli attributi che costituiscono le associazioni/chiavi esterne.
   * </p>
   * 
   * @return l'hash corrispondente all'oggetto corrente
   */
  public int hashCode() {
    
    int hashCode = 0;
    
    if (this.getDescrizione() != null) {hashCode += this.getDescrizione().hashCode();}
    if (this.getAliquota() != null) {hashCode += this.getAliquota().hashCode();}
    
    return hashCode;
   
  }

  /**
   * Imposta il valore dell'attributo 'movimentiIva'
   * 
   * <p>
   *   Il metodo non gestisce la biunivocità della relazione. Utilizzare il metodo
   *   {@link org.erossi.pigest.model.iva.AliquotaIva#aggiungiMovimentoIva(MovimentoIva)},
   *   che garantisce la corretta associazione biunivoca fra le entità.
   * </p>
   * 
   * @param movimentiIva il valore dell'attributo 'movimentiIva'
   */
  public void setMovimentiIva(Set<MovimentoIva> movimentiIva) {
    this.movimentiIva = movimentiIva;
  }
  
  /**
   * Ritorna una rappresentazione sotto forma di 
   *   stringa dell'oggetto.
   * 
   * @return una stringa che rappresenta l'oggetto
   */
  public String toString() {

    String toString = new String();
    toString = this.getClass().getName();
    
    toString += AppCtx.printDebug("super", super.toString());
    toString += AppCtx.printDebug("descrizione", descrizione);
    toString += AppCtx.printDebug("aliquota", aliquota);
    
    return toString;

  }
  
  /**
   * @return il valore dell'attributo descrizione
   */
  public String getDescrizione() {
    return descrizione;
  }

  /**
   * Imposta il valore dell'attributo 'descrizione'
   * @param descrizione il valore dell'attributo 'descrizione'
   */
  public void setDescrizione(String descrizione) {
    this.descrizione = descrizione;
  }

  /**
   * Restituisce il valore dell'attributo 'aliquota'
   * @return il valore dell'attributo aliquota
   */
  public Double getAliquota() {
    return aliquota;
  }

  /**
   * Imposta il valore dell'attributo 'aliquota'
   * @param aliquota il valore dell'attributo 'aliquota'
   */
  public void setAliquota(Double aliquota) {
    this.aliquota = aliquota;
  }

  /**
   * Restituisce il valore dell'attributo 'movimentiIva'
   * @return il valore dell'attributo movimentiIva
   */
  public Set<MovimentoIva> getMovimentiIva() {
    return movimentiIva;
  }

}

